home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / rbbs_pc / 172anew.zip / FILEVIEW.DOC < prev    next >
Text File  |  1989-05-24  |  4KB  |  104 lines
  1. Documentation on F)ile V)erbose List Function for RBBS 17.2A
  2. by Ken Goosens
  3. 24 May 1989
  4.  
  5. The V)erbose List, sometimes called View function, allows the
  6. caller to get a list of files that are "libraried" inside a
  7. single file.
  8.  
  9. Versions of RBBS prior to 17.2A supported only a proprietary,
  10. non-public-domain format of System Enhancement Associates called
  11. "arc".  17.2A internally now supports ZIP, PAK, LZH, and ARC as
  12. well.  In addition, the sysop can install support for ANY library
  13. format using external procedures.
  14.  
  15.          How to Install an External Verbose List
  16.  
  17. RBBS assumes that the file extension will identify the type of
  18. library.  Hence, all files with "ARC", "PAK", or "ZOO" have a
  19. different but common library function.
  20.  
  21. The sysop can install a Verbose List function for files with extension
  22. "xyz" as follows:
  23.  
  24. o   In the same place that config specified to look for command.com
  25.     on, put in a bat file with the name "Vxyz.BAT".  The existence
  26.     of this file tells RBBS to shell using this file to handle a
  27.     verbose list.
  28.  
  29. Warning:  shelling requires EXTRA free memory beyond what RBBS uses.
  30. If you are little or no free memory, you may be limited to only the
  31. internal verbose list in RBBS.
  32.  
  33.  
  34.               Distributed Verbose List Support
  35.  
  36. RBBS includes the following files for external verbose list:
  37.  
  38. ARCVIEW.COM - Compiled C program for verbose list of DWC, PAK, ZOO,
  39.    and ARC files.  Used in VDWC.BAT and VZOO.BAT
  40.  
  41. VDWC.BAT -  Processor for DWC files
  42. VZOO.BAT -  Processor for ZOO files
  43. VZIP.BAT -  Processor for ZIP files (uses ZIPTV.EXE)
  44.  
  45. Each BAT file contains in it:
  46.  
  47.                ARCVIEW [1] > [2]
  48.  
  49. RBBS will shell to the above program (not to the BAT file) after first
  50. substituting the name of the file to be listed for "[1]" and the
  51. name of the file containing the results of the listing for "[2]".
  52. The ">" simply redirects the listing that would normally go to
  53. the screen to "[2]".
  54.  
  55. RBBS always expects the results of the verbose list to be written to
  56. a file named "NODExWRK" when x is the node id (1,2,3,...).
  57.  
  58.           How to Implement Your Own Verbose List
  59.  
  60. Your verbose list program must have a way to receive from RBBS
  61.  
  62. o   the name of the file to list
  63.  
  64. o   the name of the file to write the listing to.
  65.  
  66. RBBS will interface with your program in two different ways:
  67. depending on how many lines your BAT file contains.
  68.  
  69. If the BAT file contains exactly 1 line, RBBS will shell to the
  70. line in the BAT file and not the BAT file.   RBBS will dynamically
  71. scan for "[1]" and "[2]" in the line and substitute the names of
  72. the file to be listed and the file to write the results to,
  73. respectively.  Everything else will be left intact.
  74.  
  75. If the BAT file contains more than one line, RBBS will shell to
  76. the BAT file, passing on the command line first the name of the file
  77. to list, and second the name of the results file.
  78.  
  79. For example, the following BAT file could be used:
  80.  
  81.            ECHO OFF
  82.            ARCVIEW %1 > %2
  83.            ECHO ON
  84.  
  85. Remember, inside a BAT file you can do any processing you want.  For
  86. example, if you want to keep a log called VIEW.LOG of the names of
  87. all files viewed, you could have
  88.  
  89.            ECHO %1 >> VIEW.LOG
  90.            ARCVIEW %1 > %2
  91.  
  92. The ">>" means to redirect the standard output to file VIEW.LOG but
  93. appends rather than replaces.
  94.  
  95.                    Using Ziptv
  96.  
  97. Ziptv is a program distributed by Samuel H. Smith which supports not
  98. only verbose list, but the ability to list any file inside of
  99. a ZIP file, thus allowing users to view documentation before downloading
  100. a file.    Many sysops will want to install ZIPTV to replace the
  101. internal RBBS verbose list.   Simply make sure ZIPTV.EXE is either in
  102. the current directory or the path, and put VZIP.BAT where config
  103. says that COMMAND.COM is.
  104.